Skip to content

Fix role-related API spec #3033

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 5 commits into from
Oct 21, 2024
Merged

Fix role-related API spec #3033

merged 5 commits into from
Oct 21, 2024

Conversation

@n1v0lg
Copy link
Contributor

@n1v0lg n1v0lg commented Oct 21, 2024 •
edited
Loading

There is a display glitch in the ES serverless API: see live spec.

where details of several APIs are rendered as API headers. This PR fixes the rendering issue by including the relevant header info in top-level comments for each affected API.

@n1v0lg n1v0lg self-assigned this Oct 21, 2024
@github-actions
Copy link
Contributor

github-actions bot commented Oct 21, 2024

Following you can find the validation results for the APIs you have changed.

API Status Request Response
security.delete_role 🟢 8/8 8/8
security.get_builtin_privileges 🔴 2/2 1/2
security.get_role 🔴 24/24 21/24
security.put_role 🔴 31/39 38/38

You can validate these APIs yourself by using the make validate target.

@n1v0lg n1v0lg marked this pull request as ready for review October 21, 2024 12:00
slobodanadamovic
slobodanadamovic approved these changes Oct 21, 2024
View reviewed changes
Copy link
Contributor

@slobodanadamovic slobodanadamovic left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Nice catch!

flobernd
flobernd reviewed Oct 21, 2024
View reviewed changes
specification/security/delete_role/SecurityDeleteRoleRequest.ts Outdated
import { Name, Refresh } from '@_types/common'

/**
* Delete roles API
Copy link
Member

@flobernd flobernd Oct 21, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There should be an empty line between the header and the description.

The JSDoc is interpreted as markdown which means that no new paragraph is created without the empty line.

Same for all other places 🙂

Copy link
Contributor Author

@n1v0lg n1v0lg Oct 21, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@flobernd thanks!

Is this what you had in mind: 071eafe?

I don't think it affected the output directory so I don't think it'll make a difference in rendering though.

Copy link
Member

@flobernd flobernd Oct 21, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@n1v0lg Yes, the previous commit looks good! It should affect the ouput as well 😅 (maybe we have a bug here in the spec compiler, if it really does not..).

@github-actions
Copy link
Contributor

github-actions bot commented Oct 21, 2024

Following you can find the validation results for the APIs you have changed.

API Status Request Response
security.delete_role 🟢 8/8 8/8
security.get_builtin_privileges 🔴 2/2 1/2
security.get_role 🔴 24/24 21/24
security.put_role 🔴 31/39 38/38

You can validate these APIs yourself by using the make validate target.

1 similar comment
@github-actions
Copy link
Contributor

github-actions bot commented Oct 21, 2024

Following you can find the validation results for the APIs you have changed.

API Status Request Response
security.delete_role 🟢 8/8 8/8
security.get_builtin_privileges 🔴 2/2 1/2
security.get_role 🔴 24/24 21/24
security.put_role 🔴 31/39 38/38

You can validate these APIs yourself by using the make validate target.

@n1v0lg n1v0lg requested a review from flobernd October 21, 2024 12:34
@github-actions
Copy link
Contributor

github-actions bot commented Oct 21, 2024

Following you can find the validation results for the APIs you have changed.

API Status Request Response
security.delete_role 🟢 8/8 8/8
security.get_builtin_privileges 🔴 2/2 1/2
security.get_role 🔴 24/24 21/24
security.put_role 🔴 31/39 38/38

You can validate these APIs yourself by using the make validate target.

@github-actions
Copy link
Contributor

github-actions bot commented Oct 21, 2024

Following you can find the validation results for the APIs you have changed.

API Status Request Response
security.delete_role 🟢 8/8 8/8
security.get_builtin_privileges 🔴 2/2 1/2
security.get_role 🔴 24/24 21/24
security.put_role 🔴 31/39 38/38

You can validate these APIs yourself by using the make validate target.

flobernd
flobernd approved these changes Oct 21, 2024
View reviewed changes
Copy link
Member

@flobernd flobernd left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! Thank you.

@n1v0lg n1v0lg merged commit 2fdec29 into main Oct 21, 2024
6 checks passed
@n1v0lg n1v0lg deleted the fix-role-mapping-related-api-spec branch October 21, 2024 13:03
This was referenced Oct 21, 2024
Merged
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@slobodanadamovic slobodanadamovic slobodanadamovic approved these changes

@flobernd flobernd flobernd approved these changes

@pquentin pquentin Awaiting requested review from pquentin

Assignees

@n1v0lg n1v0lg

Labels

specification

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@n1v0lg @slobodanadamovic @flobernd